<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Pvd</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="PhysXLogoBlack.png"/></td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__pvd.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#nested-classes">Classes</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Pvd</div>  </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for Pvd:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group__pvd.png" border="0" alt="" usemap="#group____pvd"/>
<map name="group____pvd" id="group____pvd">
<area shape="rect" id="node2" href="group__geomutils.html" title="Geomutils" alt="" coords="135,5,216,32"/>
<area shape="rect" id="node3" href="group__foundation.html" title="Foundation" alt="" coords="132,56,219,83"/>
</map>
</td></tr></table></center>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacephysx"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacephysx.html">physx</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxPvdInstrumentationFlag.html">PxPvdInstrumentationFlag</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">types of instrumentation that PVD can do.  <a href="structPxPvdInstrumentationFlag.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvd.html">PxPvd</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classPxPvd.html" title="PxPvd is the top-level class for the PVD framework, and the main customer interface for PVD configura...">PxPvd</a> is the top-level class for the PVD framework, and the main customer interface for PVD configuration.It is a singleton class, instantiated and owned by the application.  <a href="classPxPvd.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxPvdSceneFlag.html">PxPvdSceneFlag</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">PVD scene Flags. They are disabled by default, and only works if <a class="el" href="structPxPvdInstrumentationFlag.html#ae5be1bcb179a96c601194126230aeedeadaffb4216dd0bc2a5683245ea725afdf" title="Send debugging information to PVD. ">PxPvdInstrumentationFlag::eDEBUG</a> is set.  <a href="structPxPvdSceneFlag.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdSceneClient.html">PxPvdSceneClient</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Special client for <a class="el" href="classPxScene.html" title="A scene is a collection of bodies and constraints which can interact. ">PxScene</a>. It provides access to the <a class="el" href="structPxPvdSceneFlag.html" title="PVD scene Flags. They are disabled by default, and only works if PxPvdInstrumentationFlag::eDEBUG is ...">PxPvdSceneFlag</a>. It also provides simple user debug services that associated scene position such as immediate rendering and camera updates.  <a href="classPxPvdSceneClient.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdTransport.html">PxPvdTransport</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classPxPvdTransport.html" title="PxPvdTransport is an interface representing the data transport mechanism. This class defines all serv...">PxPvdTransport</a> is an interface representing the data transport mechanism. This class defines all services associated with the transport: configuration, connection, reading, writing etc. It is owned by the application, and can be realized as a file or a socket (using one-line PxDefault&lt;...&gt; methods in PhysXExtensions) or in a custom implementation. This is a class that is intended for use by PVD, not by the application, the application entry points are <a class="el" href="classPxPvd.html" title="PxPvd is the top-level class for the PVD framework, and the main customer interface for PVD configura...">PxPvd</a> and PvdClient.  <a href="classPxPvdTransport.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga4e8b7695b7145523688243b39da116c9"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classPxFlags.html">PxFlags</a>&lt; <a class="el" href="structPxPvdInstrumentationFlag.html#ae5be1bcb179a96c601194126230aeede">PxPvdInstrumentationFlag::Enum</a>, uint8_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pvd.html#ga4e8b7695b7145523688243b39da116c9">PxPvdInstrumentationFlags</a></td></tr>
<tr class="memdesc:ga4e8b7695b7145523688243b39da116c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bitfield that contains a set of raised flags defined in <a class="el" href="structPxPvdInstrumentationFlag.html" title="types of instrumentation that PVD can do. ">PxPvdInstrumentationFlag</a>.  <a href="#ga4e8b7695b7145523688243b39da116c9">More...</a><br /></td></tr>
<tr class="separator:ga4e8b7695b7145523688243b39da116c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga23ddab69994886fb588a139635bff64b"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classPxFlags.html">PxFlags</a>&lt; <a class="el" href="structPxPvdSceneFlag.html#afa6d3e9f667028233457051fe78042bd">PxPvdSceneFlag::Enum</a>, PxU8 &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pvd.html#ga23ddab69994886fb588a139635bff64b">PxPvdSceneFlags</a></td></tr>
<tr class="memdesc:ga23ddab69994886fb588a139635bff64b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bitfield that contains a set of raised flags defined in <a class="el" href="structPxPvdSceneFlag.html" title="PVD scene Flags. They are disabled by default, and only works if PxPvdInstrumentationFlag::eDEBUG is ...">PxPvdSceneFlag</a>.  <a href="#ga23ddab69994886fb588a139635bff64b">More...</a><br /></td></tr>
<tr class="separator:ga23ddab69994886fb588a139635bff64b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaf0cb52973319101ff0f34f985c5093e7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gaea189596f11f07c586d4757cc67e8f7f">PX_C_EXPORT</a> <a class="el" href="classPxPvd.html">PxPvd</a> *<a class="el" href="group__foundation.html#ga65a319adb859941e5bd98575280b8d19">PX_CALL_CONV</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pvd.html#gaf0cb52973319101ff0f34f985c5093e7">PxCreatePvd</a> (<a class="el" href="classPxFoundation.html">PxFoundation</a> &amp;foundation)</td></tr>
<tr class="memdesc:gaf0cb52973319101ff0f34f985c5093e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a pvd instance.  <a href="#gaf0cb52973319101ff0f34f985c5093e7">More...</a><br /></td></tr>
<tr class="separator:gaf0cb52973319101ff0f34f985c5093e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaba53e1ef15e10cade433600f8f7954c4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gaea189596f11f07c586d4757cc67e8f7f">PX_C_EXPORT</a> <a class="el" href="classPxPvdTransport.html">PxPvdTransport</a> *<a class="el" href="group__foundation.html#ga65a319adb859941e5bd98575280b8d19">PX_CALL_CONV</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pvd.html#gaba53e1ef15e10cade433600f8f7954c4">PxDefaultPvdSocketTransportCreate</a> (const char *host, int port, unsigned int timeoutInMilliseconds)</td></tr>
<tr class="memdesc:gaba53e1ef15e10cade433600f8f7954c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a default socket transport.  <a href="#gaba53e1ef15e10cade433600f8f7954c4">More...</a><br /></td></tr>
<tr class="separator:gaba53e1ef15e10cade433600f8f7954c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga12ad7e982ca0e3d97f15c6bac4c479a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gaea189596f11f07c586d4757cc67e8f7f">PX_C_EXPORT</a> <a class="el" href="classPxPvdTransport.html">PxPvdTransport</a> *<a class="el" href="group__foundation.html#ga65a319adb859941e5bd98575280b8d19">PX_CALL_CONV</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pvd.html#ga12ad7e982ca0e3d97f15c6bac4c479a2">PxDefaultPvdFileTransportCreate</a> (const char *name)</td></tr>
<tr class="memdesc:ga12ad7e982ca0e3d97f15c6bac4c479a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a default file transport.  <a href="#ga12ad7e982ca0e3d97f15c6bac4c479a2">More...</a><br /></td></tr>
<tr class="separator:ga12ad7e982ca0e3d97f15c6bac4c479a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga4e8b7695b7145523688243b39da116c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4e8b7695b7145523688243b39da116c9">&#9670;&nbsp;</a></span>PxPvdInstrumentationFlags</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="classPxFlags.html">PxFlags</a>&lt;<a class="el" href="structPxPvdInstrumentationFlag.html#ae5be1bcb179a96c601194126230aeede">PxPvdInstrumentationFlag::Enum</a>, uint8_t&gt; <a class="el" href="group__pvd.html#ga4e8b7695b7145523688243b39da116c9">PxPvdInstrumentationFlags</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Bitfield that contains a set of raised flags defined in <a class="el" href="structPxPvdInstrumentationFlag.html" title="types of instrumentation that PVD can do. ">PxPvdInstrumentationFlag</a>. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structPxPvdInstrumentationFlag.html" title="types of instrumentation that PVD can do. ">PxPvdInstrumentationFlag</a> </dd></dl>

</div>
</div>
<a id="ga23ddab69994886fb588a139635bff64b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga23ddab69994886fb588a139635bff64b">&#9670;&nbsp;</a></span>PxPvdSceneFlags</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="classPxFlags.html">PxFlags</a>&lt;<a class="el" href="structPxPvdSceneFlag.html#afa6d3e9f667028233457051fe78042bd">PxPvdSceneFlag::Enum</a>, PxU8&gt; <a class="el" href="group__pvd.html#ga23ddab69994886fb588a139635bff64b">PxPvdSceneFlags</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Bitfield that contains a set of raised flags defined in <a class="el" href="structPxPvdSceneFlag.html" title="PVD scene Flags. They are disabled by default, and only works if PxPvdInstrumentationFlag::eDEBUG is ...">PxPvdSceneFlag</a>. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structPxPvdSceneFlag.html" title="PVD scene Flags. They are disabled by default, and only works if PxPvdInstrumentationFlag::eDEBUG is ...">PxPvdSceneFlag</a> </dd></dl>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaf0cb52973319101ff0f34f985c5093e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf0cb52973319101ff0f34f985c5093e7">&#9670;&nbsp;</a></span>PxCreatePvd()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#gaea189596f11f07c586d4757cc67e8f7f">PX_C_EXPORT</a> <a class="el" href="classPxPvd.html">PxPvd</a>* <a class="el" href="group__foundation.html#ga65a319adb859941e5bd98575280b8d19">PX_CALL_CONV</a> PxCreatePvd </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classPxFoundation.html">PxFoundation</a> &amp;&#160;</td>
          <td class="paramname"><em>foundation</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Create a pvd instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">foundation</td><td>is the foundation instance that stores the allocator and error callbacks. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga12ad7e982ca0e3d97f15c6bac4c479a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga12ad7e982ca0e3d97f15c6bac4c479a2">&#9670;&nbsp;</a></span>PxDefaultPvdFileTransportCreate()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#gaea189596f11f07c586d4757cc67e8f7f">PX_C_EXPORT</a> <a class="el" href="classPxPvdTransport.html">PxPvdTransport</a>* <a class="el" href="group__foundation.html#ga65a319adb859941e5bd98575280b8d19">PX_CALL_CONV</a> PxDefaultPvdFileTransportCreate </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Create a default file transport. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>full path filename used save captured pvd data, or NULL for a fake/test file transport. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gaba53e1ef15e10cade433600f8f7954c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaba53e1ef15e10cade433600f8f7954c4">&#9670;&nbsp;</a></span>PxDefaultPvdSocketTransportCreate()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#gaea189596f11f07c586d4757cc67e8f7f">PX_C_EXPORT</a> <a class="el" href="classPxPvdTransport.html">PxPvdTransport</a>* <a class="el" href="group__foundation.html#ga65a319adb859941e5bd98575280b8d19">PX_CALL_CONV</a> PxDefaultPvdSocketTransportCreate </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>host</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>port</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>timeoutInMilliseconds</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Create a default socket transport. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">host</td><td>host address of the pvd application. </td></tr>
    <tr><td class="paramname">port</td><td>ip port used for pvd, should same as the port setting in pvd application. </td></tr>
    <tr><td class="paramname">timeoutInMilliseconds</td><td>timeout when connect to pvd host. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2008-2021 NVIDIA Corporation, 2788 San Tomas Expressway, Santa Clara, CA 95051 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a></li>
  </ul>
</div>
</body>
</html>
